Node / meshtastic / Meshtastic-Android / files / app / src / main / java / com / geeksville / mesh / repository / api / DeviceHardwareRepository.kt

Displaying Raw • Download

T8b949e/*

* Copyright (c) 2025 Meshtastic LLC

*

* This program is free software: you can redistribute it and/or modify

* it under the terms of the GNU General Public License as published by

* the Free Software Foundation, either version 3 of the License, or

* (at your option) any later version.

*

* This program is distributed in the hope that it will be useful,

* but WITHOUT ANY WARRANTY; without even the implied warranty of

* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

* GNU General Public License for more details.

*

* You should have received a copy of the GNU General Public License

* along with this program. If not, see <https://www.gnu.org/licenses/>.

*/

Tff7b72package T7ee787com.geeksville.mesh.repository.api

Tff7b72import T7ee787com.geeksville.mesh.android.BuildUtils.debug

Tff7b72import T7ee787com.geeksville.mesh.android.BuildUtils.warn

Tff7b72import T7ee787com.geeksville.mesh.database.entity.DeviceHardwareEntity

Tff7b72import T7ee787com.geeksville.mesh.database.entity.asExternalModel

Tff7b72import T7ee787com.geeksville.mesh.model.DeviceHardware

Tff7b72import T7ee787com.geeksville.mesh.network.DeviceHardwareRemoteDataSource

Tff7b72import T7ee787kotlinx.coroutines.Dispatchers

Tff7b72import T7ee787kotlinx.coroutines.withContext

Tff7b72import T7ee787java.io.IOException

Tff7b72import T7ee787java.util.concurrent.TimeUnit

Tff7b72import T7ee787javax.inject.Inject

Tff7b72import T7ee787javax.inject.Singleton

T8b949e// Annotating with Singleton to ensure a single instance manages the cache

Tf0883e@Singleton

Tff7b72class T56d364DeviceHardwareRepository

Tf0883e@Inject

Tff7b72constructorTb4b4b4(

Tff7b72private Tff7b72val Te6edf3remoteDataSourceTb4b4b4: Te6edf3DeviceHardwareRemoteDataSourceTb4b4b4,

Tff7b72private Tff7b72val Te6edf3localDataSourceTb4b4b4: Te6edf3DeviceHardwareLocalDataSourceTb4b4b4,

Tff7b72private Tff7b72val Te6edf3jsonDataSourceTb4b4b4: Te6edf3DeviceHardwareJsonDataSourceTb4b4b4,

Tb4b4b4) Tb4b4b4{

T8b949e/**

* Retrieves device hardware information by its model ID.

*

* This function implements a cache-aside pattern with a fallback mechanism:

* 1. Check for a valid, non-expired local cache entry.

* 2. If not found or expired, fetch fresh data from the remote API.

* 3. If the remote fetch fails, attempt to use stale data from the cache.

* 4. If the cache is empty, fall back to loading data from a bundled JSON asset.

*

* @param hwModel The hardware model identifier.

* @param forceRefresh If true, the local cache will be invalidated and data will be fetched remotely.

* @return A [Result] containing the [DeviceHardware] on success (or null if not found), or an exception on failure.

*/

Tff7b72suspend Tff7b72fun Td2a8ffgetDeviceHardwareByModelTb4b4b4(Te6edf3hwModelTb4b4b4: Tffa657IntTb4b4b4, Te6edf3forceRefreshTb4b4b4: Tffa657Boolean Tff7b72= Tff7b72falseTb4b4b4)Tb4b4b4: Te6edf3ResultTff7b72<Te6edf3DeviceHardware?Tff7b72> Tff7b72=

Te6edf3withContextTb4b4b4(Te6edf3DispatchersTb4b4b4.Te6edf3IOTb4b4b4) Tb4b4b4{

Tff7b72if Tb4b4b4(Te6edf3forceRefreshTb4b4b4) Tb4b4b4{

Te6edf3localDataSourceTb4b4b4.Te6edf3deleteAllDeviceHardwareTb4b4b4(Tb4b4b4)

Tb4b4b4} Tff7b72else Tb4b4b4{

T8b949e// 1. Attempt to retrieve from cache first

Tff7b72val Te6edf3cachedEntity Tff7b72= Te6edf3localDataSourceTb4b4b4.Te6edf3getByHwModelTb4b4b4(Te6edf3hwModelTb4b4b4)

Tff7b72if Tb4b4b4(Te6edf3cachedEntity Tff7b72!Tff7b72= Tff7b72null Tff7b72&Tff7b72& Tff7b72!Te6edf3cachedEntityTb4b4b4.Te6edf3isStaleTb4b4b4(Tb4b4b4)Tb4b4b4) Tb4b4b4{

Te6edf3debugTb4b4b4(Ta5d6ff"Ta5d6ffUsing fresh cached device hardware for model Tffd700$Te6edf3hwModelTa5d6ff"Tb4b4b4)

Tff7b72returnTf0883e@withContext Te6edf3ResultTb4b4b4.Te6edf3successTb4b4b4(Te6edf3cachedEntityTb4b4b4.Te6edf3asExternalModelTb4b4b4(Tb4b4b4)Tb4b4b4)

Tb4b4b4}

Tb4b4b4}

T8b949e// 2. Fetch from remote API

Te6edf3runCatching Tb4b4b4{

Te6edf3debugTb4b4b4(Ta5d6ff"Ta5d6ffFetching device hardware from remote API.Ta5d6ff"Tb4b4b4)

Tff7b72val Te6edf3remoteHardware Tff7b72=

Te6edf3remoteDataSourceTb4b4b4.Te6edf3getAllDeviceHardwareTb4b4b4(Tb4b4b4) Tff7b72?: Tff7b72throw Te6edf3IOExceptionTb4b4b4(Ta5d6ff"Ta5d6ffEmpty response from serverTa5d6ff"Tb4b4b4)

Te6edf3localDataSourceTb4b4b4.Te6edf3insertAllDeviceHardwareTb4b4b4(Te6edf3remoteHardwareTb4b4b4)

Te6edf3localDataSourceTb4b4b4.Te6edf3getByHwModelTb4b4b4(Te6edf3hwModelTb4b4b4)Tff7b72?.Te6edf3asExternalModelTb4b4b4(Tb4b4b4)

Tb4b4b4}

Tb4b4b4.Te6edf3onSuccess Tb4b4b4{

T8b949e// Successfully fetched and found the model

Tff7b72returnTf0883e@withContext Te6edf3ResultTb4b4b4.Te6edf3successTb4b4b4(Tffa657itTb4b4b4)

Tb4b4b4}

Tb4b4b4.Te6edf3onFailure Tb4b4b4{ Te6edf3e Tff7b72-Tff7b72>

Te6edf3warnTb4b4b4(Ta5d6ff"Ta5d6ffFailed to fetch device hardware from server: Tffd700${Te6edf3eTb4b4b4.Te6edf3messageTffd700}Ta5d6ff"Tb4b4b4)

T8b949e// 3. Attempt to use stale cache as a fallback

Tff7b72val Te6edf3staleEntity Tff7b72= Te6edf3localDataSourceTb4b4b4.Te6edf3getByHwModelTb4b4b4(Te6edf3hwModelTb4b4b4)

Tff7b72if Tb4b4b4(Te6edf3staleEntity Tff7b72!Tff7b72= Tff7b72nullTb4b4b4) Tb4b4b4{

Te6edf3debugTb4b4b4(Ta5d6ff"Ta5d6ffUsing stale cached device hardware for model Tffd700$Te6edf3hwModelTa5d6ff"Tb4b4b4)

Tff7b72returnTf0883e@withContext Te6edf3ResultTb4b4b4.Te6edf3successTb4b4b4(Te6edf3staleEntityTb4b4b4.Te6edf3asExternalModelTb4b4b4(Tb4b4b4)Tb4b4b4)

Tb4b4b4}

T8b949e// 4. Fallback to bundled JSON if cache is empty

Te6edf3debugTb4b4b4(Ta5d6ff"Ta5d6ffCache is empty, falling back to bundled JSON asset.Ta5d6ff"Tb4b4b4)

Tff7b72returnTf0883e@withContext Te6edf3loadFromBundledJsonTb4b4b4(Te6edf3hwModelTb4b4b4)

Tb4b4b4}

Tb4b4b4}

Tff7b72private Tff7b72suspend Tff7b72fun Td2a8ffloadFromBundledJsonTb4b4b4(Te6edf3hwModelTb4b4b4: Tffa657IntTb4b4b4)Tb4b4b4: Te6edf3ResultTff7b72<Te6edf3DeviceHardware?Tff7b72> Tff7b72= Te6edf3runCatching Tb4b4b4{

Tff7b72val Te6edf3jsonHardware Tff7b72= Te6edf3jsonDataSourceTb4b4b4.Te6edf3loadDeviceHardwareFromJsonAssetTb4b4b4(Tb4b4b4)

Te6edf3localDataSourceTb4b4b4.Te6edf3insertAllDeviceHardwareTb4b4b4(Te6edf3jsonHardwareTb4b4b4)

Te6edf3localDataSourceTb4b4b4.Te6edf3getByHwModelTb4b4b4(Te6edf3hwModelTb4b4b4)Tff7b72?.Te6edf3asExternalModelTb4b4b4(Tb4b4b4)

Tb4b4b4}

T8b949e/** Extension function to check if the cached entity is stale. */

Tff7b72private Tff7b72fun Te6edf3DeviceHardwareEntityTb4b4b4.Td2a8ffisStaleTb4b4b4(Tb4b4b4)Tb4b4b4: Tffa657Boolean Tff7b72=

Tb4b4b4(Te6edf3SystemTb4b4b4.Te6edf3currentTimeMillisTb4b4b4(Tb4b4b4) Tff7b72- Tff7b72thisTb4b4b4.Te6edf3lastUpdatedTb4b4b4) Tff7b72> Te6edf3CACHE_EXPIRATION_TIME_MS

Tff7b72companion Tff7b72object Tb4b4b4{

Tff7b72private Tff7b72val Te6edf3CACHE_EXPIRATION_TIME_MS Tff7b72= Te6edf3TimeUnitTb4b4b4.Te6edf3DAYSTb4b4b4.Te6edf3toMillisTb4b4b4(T79c0ff1Tb4b4b4)

Tb4b4b4}

Tb4b4b4}